<html>
<head>
    <title>XBRLAPI Exist database setup suggestions</title>
    <link rel="stylesheet" href="/css/styles.css" type="text/css"/>
    <script type="text/javascript">
        var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
        document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
    </script>
    <script type="text/javascript">
        try {
            var pageTracker = _gat._getTracker("UA-11401995-1");
            pageTracker._setDomainName("none");
            pageTracker._setAllowLinker(true);
            pageTracker._trackPageview();
        } catch (err) {
        }</script>
</head>


<body>
<div class="logo_container">
	<span class="logo">
		<a class="title" href="/">XBRLAPI</a>
	</span>
	<span class="logo_subscript">
		<a class="title" href="http://en.wikipedia.org/wiki/Free_and_open_source_software">Free Open-Source Software</a>
	</span>
</div>

<div id="navcontainer">
    <form action="http://www.xbrlapi.org/search.html" id="cse-search-box">
        <div>
            <input type="hidden" name="cx" value="partner-pub-3957505011939955:jqid48zd81o"/>
            <input type="hidden" name="cof" value="FORID:10"/>
            <input type="hidden" name="ie" value="ISO-8859-1"/>
            <input type="text" name="q" size="31"/>
            <input type="submit" name="sa" value="Search"/>
        </div>
    </form>

    <script
            type="text/javascript"
            src="http://www.google.com/cse/brand?form=cse-search-box&amp;lang=en">
    </script>

    <ul id="navlist">
        <li><a href="/">Home</a></li>
        <li><a href="testConfigurationFile.html">Configuration Properties</a></li>
    </ul>

    <script type="text/javascript"><!--
    google_ad_client = "pub-3957505011939955";
    /* XBRLAPI site */
    google_ad_slot = "4927123290";
    google_ad_width = 160;
    google_ad_height = 600;
    //-->
    </script>
    <script type="text/javascript"
            src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
    </script>

</div>

<div class="content">

    <h1>eXist data store configuration</h1>

    <p>
        The XBRLAPI supports version 1.4 of the eXist XML database.
        <em>It no longer supports earlier versions of eXist.</em>
    </p>

    <p>This page is relevant to those looking to use the XBRLAPI with the
        eXist data store either stand-alone or as an embedded database.
        It provides terse suggestions on the steps
        required to get the eXist database running in a manner that will permit
        interaction from the XBRLAPI.</p>

    <p>For full details see the <a href="http://exist.sourceforge.net/">eXist homepage</a>.</p>

    <p>You will need to download or otherwise have the xbrlapi-exist-X.X.jar module on the
        class path to use the stand-alone eXist data store.</p>

    <p>You will need to download or otherwise have the xbrlapi-exist-embedded-X.X.jar module on the
        class path to use the stand-alone eXist data store.</p>

    <h2>Setting eXist up within the default Jetty Container as a stand-alone database</h2>

    <p>Install your <a href="java.html">Java SDK</a></p>

    <p>Download the most recent <a href="http://exist.sourceforge.net/">eXist installer JAR file</a>
        and follow the instructions on <a href="http://exist.sourceforge.net/download.html">the eXist download page</a>
        for doing the installation.</p>

    <p>If you do not want to run the eXist web application on the default port,
        modify the [exist installation]/tools/jetty/etc/jetty.xml file to use your
        preferred port. This is useful to avoid conflicts with other web application containers
        and web servers.</p>

    <p>Check that the Exist database is running by entering the URL <a
            href="http://localhost:8089/exist/">http://localhost:8089/exist/</a>,
        presuming that you have chosen to 8089 as your port.
        You should see a local homepage
        for eXist if you have installed successfully. Check that you can
        log in as an administrator using the "admin" userid and the password you chose for the
        database during the installation process. The password used for unit testing the
        XBRLAPI is "password". Change this in the unit test configuration if you are using
        a different password.
    </p>

    <p>
        Browsing the database collections as the administrator will
        fail if the file permissions for the database files are set wrongly in
        the web application. Check the installation instructions for eXist for
        more details on trouble shooting such problems. These files are to be
        found in the webapp/WEB_INF/data directory of the eXist installation.</p>

    <p>Once eXist is installed in the Java servlet container, you should be able
        to run all of the unit tests in the unit testing suite provided by
        <code>org.xbrlapi.data.exist.tests.AllTests</code>. If you run into
        problems make sure that the eXist test configuration parameters reflect
        your own eXist installation.</p>

    <h2>Setting eXist up as an embedded database</h2>

    <p>Use xbrlapi-exist-embedded-X.X.jar</p>

    <p>Make sure you have a copy of the eXist configuration file conf.xml in a directory that you have
        specified using the exist.home system property.</p>

    <p>Run the application using the embedded exist database specifying -Dexist.home as a JRE parameter.</p>

    <p>
        <a href="http://sourceforge.net/projects/xbrlapi"><img
                src="http://sflogo.sourceforge.net/sflogo.php?group_id=135539&type=11" width="120" height="30"
                border="0"
                alt="Get Java XBRL API implementation at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a>
    </p>

</div>

</body>
</html>
